Skip to content

docs: add versioned command documentation structure#28

Merged
utkarsh232005 merged 1 commit into
KDM-cli:mainfrom
blut-agent:fix/versioned-docs
May 16, 2026
Merged

docs: add versioned command documentation structure#28
utkarsh232005 merged 1 commit into
KDM-cli:mainfrom
blut-agent:fix/versioned-docs

Conversation

@blut-agent
Copy link
Copy Markdown
Contributor

@blut-agent blut-agent commented May 16, 2026

Summary

Closes #25 by introducing a structured, versioned documentation system for KDM CLI commands.

What's Changed

Added docs/v1.2.1/ directory with comprehensive documentation for all CLI commands:

Structure

docs/
└── v1.2.1/
    ├── README.md              — Version overview, command index, quick start
    ├── show/README.md         — kdm show (runners, pods, containers, minikube)
    ├── health/README.md       — kdm health (pods, containers, all)
    ├── watch/README.md        — kdm watch (live monitoring)
    ├── logs/README.md         — kdm logs (container/pod logs)
    └── config/README.md       — kdm config (setup, set, list, clear)

Per-Command Documentation

Each command doc includes:

  • Overview — Purpose and supported environments
  • Syntax — Command usage with examples
  • Parameters & Options — Table of arguments and flags
  • Example Usage — Practical real-world examples
  • Expected Output — Sample terminal output
  • Use Cases — When and why to use the command
  • Common Errors — Known issues and troubleshooting
  • Version Info — v1.2.1 banner on every page

Version Tracking

  • Version banner on every document
  • Version history table in main README
  • Clear version references throughout

Benefits

  • Better onboarding for new users
  • Scalable documentation architecture for future releases
  • Easier maintenance as the CLI evolves
  • Improved developer productivity

@blut-agent
docs: add versioned command documentation structure
5f4e63b 
Introduce a structured, version-based documentation system for KDM CLI
commands. This addresses issue KDM-cli#25 by creating a dedicated docs/ directory
with versioned command documentation.

Structure:
  docs/v1.2.1/README.md          — Version overview and command index
  docs/v1.2.1/show/README.md     — show (runners, pods, containers, minikube)
  docs/v1.2.1/health/README.md   — health (pods, containers, all)
  docs/v1.2.1/watch/README.md    — watch (live monitoring)
  docs/v1.2.1/logs/README.md     — logs (container/pod logs)
  docs/v1.2.1/config/README.md   — config (setup, set, list, clear)

Each command doc includes: overview, syntax, parameters, examples,
expected output, use cases, and common errors. Version info is included
in every document for traceability.
@blut-agent blut-agent requested a review from utkarsh232005 as a code owner May 16, 2026 06:44
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 16, 2026

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (6)
  • docs/v1.2.1/README.md is excluded by none and included by none
  • docs/v1.2.1/config/README.md is excluded by none and included by none
  • docs/v1.2.1/health/README.md is excluded by none and included by none
  • docs/v1.2.1/logs/README.md is excluded by none and included by none
  • docs/v1.2.1/show/README.md is excluded by none and included by none
  • docs/v1.2.1/watch/README.md is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2cac3319-31bf-4cd7-92bd-443020829277

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

utkarsh232005
utkarsh232005 reviewed May 16, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@utkarsh232005 utkarsh232005 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! The PR successfully addresses all the required changes. Thank you for the contribution, @blut-agent—hoping to see more contributions from you in the future!

@utkarsh232005 utkarsh232005 merged commit e02845d into KDM-cli:main May 16, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@utkarsh232005 utkarsh232005 utkarsh232005 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Documentation: Introduce Versioned Command Documentation Structure

2 participants

@blut-agent @utkarsh232005